Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Document the Elasticsearch output's 'preset' field #37315

Merged
merged 5 commits into from
Jan 10, 2024
Merged

Document the Elasticsearch output's 'preset' field #37315

merged 5 commits into from
Jan 10, 2024

Conversation

faec
Copy link
Contributor

@faec faec commented Dec 6, 2023

Proposed commit message

Document the preset setting added to the Elasticsearch output in #37259.

Checklist

  • My code follows the style guidelines of this project
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • I have made corresponding change to the default configuration files
  • I have added tests that prove my fix is effective or that my feature works
  • I have added an entry in CHANGELOG.next.asciidoc or CHANGELOG-developer.next.asciidoc.

@faec faec added docs Team:Elastic-Agent Label for the Agent team backport-v8.12.0 Automated backport with mergify labels Dec 6, 2023
@faec faec self-assigned this Dec 6, 2023
@botelastic botelastic bot added needs_team Indicates that the issue/PR needs a Team:* label and removed needs_team Indicates that the issue/PR needs a Team:* label labels Dec 6, 2023
faec
faec commented Dec 6, 2023
View reviewed changes
libbeat/outputs/elasticsearch/docs/elasticsearch.asciidoc
@@ -701,7 +701,7 @@ The default is 3s.

The http request timeout in seconds for the Elasticsearch request. The default is 90.

==== `allow_older_versions`
===== `allow_older_versions`
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is an unrelated typo I fixed as long as I'm in here -- this field was on a different header level than all other fields in this section.

@faec faec marked this pull request as ready for review December 6, 2023 16:08
@faec faec requested a review from a team as a code owner December 6, 2023 16:08
@elasticmachine
Copy link
Collaborator

💚 Build Succeeded

the below badges are clickable and redirect to their specific view in the CI or DOCS
Pipeline View Test View Changes Artifacts preview preview

Expand to view the summary

Build stats

  • Duration: 8 min 14 sec

❕ Flaky test report

No test was executed to be analysed.

🤖 GitHub comments

Expand to view the GitHub comments

To re-run your PR in the CI, just comment with:

  • /test : Re-trigger the build.

  • /package : Generate the packages and run the E2E tests.

  • /beats-tester : Run the installation tests with beats-tester.

  • run elasticsearch-ci/docs : Re-trigger the docs validation. (use unformatted text in the comment!)

karenzone
karenzone approved these changes Dec 6, 2023
View reviewed changes
Copy link
Contributor

@karenzone karenzone left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice job explaining a complex concept, @faec. Please consider adding a code snippet.
Your explanation makes it clear what this option is and what it does, but I'm not clear on how a user would configure this option. I'll leave it up to you if you think that would be helpful.

@elasticmachine
Copy link
Collaborator

💚 Build Succeeded

the below badges are clickable and redirect to their specific view in the CI or DOCS
Pipeline View Test View Changes Artifacts preview preview

Expand to view the summary

Build stats

  • Duration: 9 min 35 sec

❕ Flaky test report

No test was executed to be analysed.

🤖 GitHub comments

Expand to view the GitHub comments

To re-run your PR in the CI, just comment with:

  • /test : Re-trigger the build.

  • /package : Generate the packages and run the E2E tests.

  • /beats-tester : Run the installation tests with beats-tester.

  • run elasticsearch-ci/docs : Re-trigger the docs validation. (use unformatted text in the comment!)

@ycombinator
Copy link
Contributor

Do we plan to document the performance impacts of the various presets from the table in elastic/elastic-agent#3797 somewhere in our docs as well?

@nimarezainia
Copy link
Contributor

Do we plan to document the performance impacts of the various presets from the table in elastic/elastic-agent#3797 somewhere in our docs as well?

i do plan to add (somewhere) in our docs the performance results. Haven't figured out yet how and where to put them.

@elasticmachine
Copy link
Collaborator

💚 Build Succeeded

the below badges are clickable and redirect to their specific view in the CI or DOCS
Pipeline View Test View Changes Artifacts preview preview

Expand to view the summary

Build stats

  • Start Time: 2024-01-08T22:46:16.156+0000

  • Duration: 8 min 18 sec

❕ Flaky test report

No test was executed to be analysed.

🤖 GitHub comments

Expand to view the GitHub comments

To re-run your PR in the CI, just comment with:

  • /test : Re-trigger the build.

  • /package : Generate the packages and run the E2E tests.

  • /beats-tester : Run the installation tests with beats-tester.

  • run elasticsearch-ci/docs : Re-trigger the docs validation. (use unformatted text in the comment!)

@elasticmachine
Copy link
Collaborator

❕ Build Aborted

There is a new build on-going so the previous on-going builds have been aborted.

the below badges are clickable and redirect to their specific view in the CI or DOCS
Pipeline View Test View Changes Artifacts preview

Expand to view the summary

Build stats

  • Start Time: 2024-01-08T23:19:38.367+0000

  • Duration: 7 min 0 sec

🤖 GitHub comments

Expand to view the GitHub comments

To re-run your PR in the CI, just comment with:

  • /test : Re-trigger the build.

  • /package : Generate the packages and run the E2E tests.

  • /beats-tester : Run the installation tests with beats-tester.

  • run elasticsearch-ci/docs : Re-trigger the docs validation. (use unformatted text in the comment!)

@elasticmachine
Copy link
Collaborator

💚 Build Succeeded

the below badges are clickable and redirect to their specific view in the CI or DOCS
Pipeline View Test View Changes Artifacts preview preview

Expand to view the summary

Build stats

  • Duration: 8 min 3 sec

❕ Flaky test report

No test was executed to be analysed.

🤖 GitHub comments

Expand to view the GitHub comments

To re-run your PR in the CI, just comment with:

  • /test : Re-trigger the build.

  • /package : Generate the packages and run the E2E tests.

  • /beats-tester : Run the installation tests with beats-tester.

  • run elasticsearch-ci/docs : Re-trigger the docs validation. (use unformatted text in the comment!)

ycombinator
ycombinator approved these changes Jan 10, 2024
View reviewed changes
Copy link
Contributor

@ycombinator ycombinator left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM.

@faec faec merged commit 0c73852 into elastic:main Jan 10, 2024
8 checks passed
@faec faec deleted the preset-docs branch January 10, 2024 17:42
mergify bot pushed a commit that referenced this pull request Jan 10, 2024
@faec @mergify
Document the Elasticsearch output's 'preset' field (#37315)
85134f6 
(cherry picked from commit 0c73852)
@mergify mergify bot mentioned this pull request Jan 10, 2024
Merged
pierrehilbert pushed a commit that referenced this pull request Jan 10, 2024
@mergify @faec
Document the Elasticsearch output's 'preset' field (#37315) (#37603)
27c5927 
(cherry picked from commit 0c73852)

Co-authored-by: Fae Charlton <[email protected]>
Scholar-Li pushed a commit to Scholar-Li/beats that referenced this pull request Feb 5, 2024
@faec @Scholar-Li
Document the Elasticsearch output's 'preset' field (elastic#37315)
eaf206e
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@ycombinator ycombinator ycombinator approved these changes

@karenzone karenzone karenzone approved these changes

@leehinman leehinman Awaiting requested review from leehinman leehinman is a code owner automatically assigned from elastic/elastic-agent-data-plane

Assignees

@faec faec

Labels
backport-v8.12.0 Automated backport with mergify docs Team:Elastic-Agent Label for the Agent team
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@faec @elasticmachine @ycombinator @nimarezainia @karenzone